ci: add GitHub Actions workflow to build and deploy MkDocs documentation#462
Closed
Sidhant185 wants to merge 1 commit intomllam:mainfrom
Closed
ci: add GitHub Actions workflow to build and deploy MkDocs documentation#462Sidhant185 wants to merge 1 commit intomllam:mainfrom
Sidhant185 wants to merge 1 commit intomllam:mainfrom
Conversation
21 tasks
Collaborator
|
please discuss the CICD workflows for autodocs directly in #230 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Describe your changes
Add
.github/workflows/docs.yml— a GitHub Actions workflow thatautomatically builds and deploys MkDocs documentation to GitHub Pages.
Workflow behaviour:
mainand on pull requests targetingmainuvdocsdependency group (mkdocs,mkdocs-material,mkdocstrings[python])mkdocs build --strict(fails CI on any warning)mkdocs gh-deployonly on merges tomainThis builds on top of the MkDocs structure added in #457.
Issue Link
closes #461
relates to #61
Type of change
Checklist before requesting a review
Checklist for reviewers
Each PR comes with its own improvements and flaws. The reviewer should check the following:
Author checklist after completed review
GitHub Pages
Checklist for assignee